Tạo người dùng mới

API này giúp bạn tạo và đồng bộ một tài khoản người dùng mới trên hệ thống PiScale.

HTTP request

POST https://{app_id}.api.piscale.com/user/v1.0/user

Request header

Bảng mô tả tham số của request header:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
X-Api-Key	string	API Key của ứng dụng	✓
X-Tenant-Id	string	Chỉ định tạo user cho tenant nào (ID bên hệ thống của bạn)	✗

Request body

Content-Type: application/json

Ví dụ

{
    "user_id": "49918031",
    "display_name": "Emily Johnson",
    "alias": "emily_johnson92",
    "avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/20b8582d-6beb-4161-b157-f7d2bf290962.png",
    "user_type_id": 1,
    "verified": true
}

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
user_id	string	ID định danh người dùng trong hệ thống của bạn Tối đa 80 ký tự	✓
display_name	string	Tên hiển thị Tối đa 80 ký tự	✓
alias	string	Tên viết tắt/biệt danh Tối đa 80 ký tự	✗
avatar_url	string	Link ảnh đại diện Tối đa 2048 ký tự	✗
user_type_id	number	Loại người dùng Mặc định là "Default" nếu không điền	✗
verified	bool	Trạng thái xác thực người dùng	✗

Responses

Khi tạo thành công, bạn sẽ nhận được response:

Status: 200 OK

{
  "data": {
    "user_id": "49918031",
    "ext_user_id": "6872016393206737",
    "tenant_id": "89915020",
    "ext_tenant_id": "6872016393176737",
    "display_name": "Emily Johnson",
    "alias": "emily_johnson92",
    "avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/20b8582d-6beb-4161-b157-f7d2bf290962.png",
    "status": 1,
    "type": 1,
    "verified": true
  },
  "message_code": "M200",
  "message": "Success"
}

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã phản hồi. Xem chi tiết
message	string	Thông báo phản hồi
data	object	Thông tin người dùng đã tạo
data.user_id	string	ID người dùng trong hệ thống của bạn
data.ext_user_id	string	ID PiScale tự sinh (map 1-1 với user_id)
data.tenant_id	string	ID tenant trong hệ thống của bạn
data.ext_tenant_id	string	ID tenant PiScale tự sinh
data.display_name	string	Tên hiển thị
data.alias	string	Tên viết tắt/biệt danh
data.avatar_url	string	Link ảnh đại diện
data.status	number	Trạng thái của user. 1: ACTIVE, 2: INACTIVE
data.type	number	Loại user. 1: USER, 2: BOT
data.verified	bool	Trạng thái xác thực